/* Copyright 2018-2023 The TensorFlow Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=======================================================================*/

// This class has been generated, DO NOT EDIT!

package org.tensorflow.op.core;

import java.util.Arrays;
import org.tensorflow.GraphOperation;
import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.RawOp;
import org.tensorflow.op.RawOpInputs;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Endpoint;
import org.tensorflow.op.annotation.OpInputsMetadata;
import org.tensorflow.op.annotation.OpMetadata;
import org.tensorflow.op.annotation.Operator;
import org.tensorflow.proto.DataType;
import org.tensorflow.types.family.TType;

/**
 * Looks up keys in a table, outputs the corresponding values.
 * The tensor {@code keys} must of the same type as the keys of the table.
 * The output {@code values} is of the type of the table values.
 * <p>The scalar {@code default_value} is the value output for keys not present in the
 * table. It must also be of the same type as the table values.
 *
 * @param <U> data type for {@code values} output
 */
@OpMetadata(
    opType = LookupTableFind.OP_NAME,
    inputsClass = LookupTableFind.Inputs.class
)
@Operator
public final class LookupTableFind<U extends TType> extends RawOp implements Operand<U> {
  /**
   * The name of this op, as known by TensorFlow core engine
   */
  public static final String OP_NAME = "LookupTableFindV2";

  private Output<U> values;

  public LookupTableFind(Operation operation) {
    super(operation, OP_NAME);
    int outputIdx = 0;
    values = operation.output(outputIdx++);
  }

  /**
   * Factory method to create a class wrapping a new LookupTableFindV2 operation.
   *
   * @param scope current scope
   * @param tableHandle Handle to the table.
   * @param keys Any shape.  Keys to look up.
   * @param defaultValue The defaultValue value
   * @param <U> data type for {@code LookupTableFindV2} output and operands
   * @return a new instance of LookupTableFind
   */
  @Endpoint(
      describeByClass = true
  )
  public static <U extends TType> LookupTableFind<U> create(Scope scope,
      Operand<? extends TType> tableHandle, Operand<? extends TType> keys,
      Operand<U> defaultValue) {
    OperationBuilder opBuilder = scope.opBuilder(OP_NAME, "LookupTableFind");
    opBuilder.addInput(tableHandle.asOutput());
    opBuilder.addInput(keys.asOutput());
    opBuilder.addInput(defaultValue.asOutput());
    return new LookupTableFind<>(opBuilder.build());
  }

  /**
   * Gets values.
   * Same shape as {@code keys}.  Values found in the table, or {@code default_values}
   * for missing keys.
   * @return values.
   */
  public Output<U> values() {
    return values;
  }

  @Override
  public Output<U> asOutput() {
    return values;
  }

  @OpInputsMetadata(
      outputsClass = LookupTableFind.class
  )
  public static class Inputs<U extends TType> extends RawOpInputs<LookupTableFind<U>> {
    /**
     * Handle to the table.
     */
    public final Operand<? extends TType> tableHandle;

    /**
     * Any shape.  Keys to look up.
     */
    public final Operand<? extends TType> keys;

    /**
     * The defaultValue input
     */
    public final Operand<U> defaultValue;

    /**
     * The Tin attribute
     */
    public final DataType Tin;

    /**
     * The Tout attribute
     */
    public final DataType Tout;

    public Inputs(GraphOperation op) {
      super(new LookupTableFind<>(op), op, Arrays.asList("Tin", "Tout"));
      int inputIndex = 0;
      tableHandle = (Operand<? extends TType>) op.input(inputIndex++);
      keys = (Operand<? extends TType>) op.input(inputIndex++);
      defaultValue = (Operand<U>) op.input(inputIndex++);
      Tin = op.attributes().getAttrType("Tin");
      Tout = op.attributes().getAttrType("Tout");
    }
  }
}
